/* Copyright  2009
   @Author
   Richard Changde Yin            e-mail yinchangde@hotmail.com

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; version 2 of the License.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */

/**
 * @filename index_hint.cc
 *
 * Implementation of SQL index hints
 */
#include<server_includes.h>
#include <sql_string.h>
#include <session.h>
#include <index_hint.h>

#include <sql_table.h>

/*
 * Names of the index hints (for error messages). Keep in sync with
 * index_hint_type
 */
const char *index_hint_type_name[] =
{
  "IGNORE INDEX"
, "USE INDEX"
, "FORCE INDEX"
};

/**
 * Print an index hint
 *
 * Prints out the USE|FORCE|IGNORE index hint.
 *
 * @param Session pointer
 * @param[out] Appends the index hint here
 */
void Index_hint::print(Session *session, String *str)
{
  str->append(STRING_WITH_LEN(index_hint_type_name[type]));
  str->append(STRING_WITH_LEN(" ("));
  if (key_name.length)
  {
    if (session && is_primary_key_name(key_name.str))
      str->append(is_primary_key_name(key_name.str));
    else
      str->append_identifier(key_name.str, key_name.length);
  }
  str->append(')');
}
